/*
 * Copyright (c) 2002-2007, Mairie de Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.customisation.business.tab;

import fr.paris.lutece.portal.business.portlet.Portlet;
import fr.paris.lutece.util.ReferenceList;

import java.util.List;


/**
 * ICustomisationTabDAO Interface
 */
public interface ICustomisationTabDAO
{
    /**
     * Load the data of a tab in a specific tab from the database
     *
     * @param nIdTab the tab identifier
     * @return  the object tab initialized with the data of the database
     */
    CustomisationTab load( int nIdTab );

    /**
     * Insert a new record in the table
     *
     * @param strNameTab the tab name
     * @param strUserName the user identifier
     * @param nOrderTab the order of the tab
     * @param nIdTemplate the template identifier
     * @param strCodeTheme the code of the theme
     * @param firstColumnWidth the width of the first column
     * @param secondColumnWidth the width of the second column
     * @param thirdColumnWidth the width of the third column
     */
    void insert( String strNameTab, String strUserName, int nOrderTab, int nIdTemplate, String strCodeTheme, int firstColumnWidth, int secondColumnWidth, int thirdColumnWidth );

    /**
     * Update the record in the table
     *
     * @param nIdTab the tab identifier
     * @param strNameTab the tab name
     * @param strUserName the user identifier
     * @param nOrderTab the order of the tab
     * @param nIdTemplate the template identifier
     * @param strCodeTheme the code of the theme
     * @param firstColumnWidth the width of the first column
     * @param secondColumnWidth the width of the second column
     * @param thirdColumnWidth the width of the third column
     */
    void store( int nIdTab, String strNameTab, String strUserName, int nOrderTab, int nIdTemplate, String strCodeTheme, int firstColumnWidth, int secondColumnWidth, int thirdColumnWidth  );

    /**
     * Delete a record from the table
     *
     * @param nIdTab the tab identifier
     * @param strUserName the user identifier
     */
    void delete( int nIdTab, String strUserName );

    /**
     * Returns the list of a tab according the user identifier
     *
     * @param strUserName the user identifier
     * @return the list of a tab according the user identifier
     */
    ReferenceList selectAllTabUser( String strUserName );

    /**
     * Returns a list of tabs according the user identifier
     *
     * @param strUserName the user identifier
     * @return the user's tab in form of Collection
     */
    List<CustomisationTab> selectTabUser( String strUserName );

    /**
     * Returns a list of tabs according the user identifier and the tab identifier
     *
     * @param nIdTab the tab identifier
     * @return the user's portlet according a tab in form of Collection
     */
    List<Portlet> loadPortlets( int nIdTab );

    /**
     * Returns the last tab created by the User
     *
     * @param strUserName The user identifier
     * @return the last tab created by the User
     */
    int selectLastTab( String strUserName );

    /**
     * Returns a boolean condition about the presence or not of an user
     *
     * @param strUserName The user identifier
     * @return a boolean condition
     */
    boolean checkUser( String strUserName );

    /**
     * Returns the tab's number for an user
     *
     * @param strUserName The user identifier
     * @return The tab's number for an user
     */
    int selectCountTabByUser( String strUserName );
}
